home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIXPIProgressDialog.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.4 KB  |  83 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is the Mozilla XPInstall.
  15.  *
  16.  * The Initial Developer of the Original Code is
  17.  * Netscape Communications Corporation.
  18.  * Portions created by the Initial Developer are Copyright (C) 2002
  19.  * the Initial Developer. All Rights Reserved.
  20.  *
  21.  * Contributor(s):
  22.  *      Daniel Veditz <dveditz@netscape.com>
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39.  
  40. /**
  41.  * Interface to display XPInstall download and install status.
  42.  *
  43.  * @status UNDER_REVIEW
  44.  */
  45. [scriptable, uuid(ce8f744e-d5a5-41b3-911f-0fee3008b64e)]
  46. interface nsIXPIProgressDialog : nsISupports
  47. {
  48.     /**
  49.      * state values for onStateChange
  50.      */
  51.     const short DOWNLOAD_START       = 0;
  52.     const short DOWNLOAD_DONE        = 1;
  53.     const short INSTALL_START        = 2;
  54.     const short INSTALL_DONE         = 3;
  55.     const short DIALOG_CLOSE         = 4;
  56.  
  57.     /**
  58.      * basic info to control the install progress dialog. The dialog can
  59.      * go away any time after it has received the DIALOG_CLOSE state message
  60.      * but needs to accept messages until that time even if it is not visible.
  61.      *
  62.      * Normally for each install package the dialog will receive the download
  63.      * and install messages in START/DONE pairs, but in the case of a download
  64.      * error the dialog will be sent only the DOWNLOAD_START followed by an
  65.      * INSTALL_DONE message with the value nsInstall::DOWNLOAD_ERROR
  66.      *
  67.      * @param index     the package this message is about of those passed into
  68.      *                  openProgressDialog. ignored when state==DIALOG_CLOSE
  69.      * @param state     the kind of message
  70.      * @param value     final result when state==INSTALL_DONE, otherwise ignored
  71.      */
  72.     void onStateChange( in unsigned long index, in short state, in long value );
  73.  
  74.     /**
  75.      * download progress
  76.      *
  77.      * @param index     the package to which this refers
  78.      * @param value     number of bytes downloaded
  79.      * @param maxValue  the total size
  80.      */
  81.     void onProgress( in unsigned long index, in unsigned long long value, in unsigned long long maxValue );
  82. };
  83.